/*
 * Copyright:  2018 smarabbit studio.
 *
 *  Licensed under the Confluent Community License; you may not use this file
 *  except in compliance with the License.  You may obtain a copy of the License at
 *
 *  http://www.confluent.io/confluent-community-license
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *  WARRANTIES OF ANY KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations under the License.
 *
 *  @作   者： 黄开晖 (117227773@qq.com)
 *  @日   期:  2021年5月23日
 */
package com.massyframework.beanskin.framework;

import java.util.List;
import java.util.function.Consumer;

import com.massyframework.beanskin.ModuleListener;
import com.massyframework.beanskin.assembly.beans.BeanExistsException;
import com.massyframework.beanskin.assembly.beans.BeanRegistry;
import com.massyframework.beanskin.service.ExportServiceDescriptor;
import com.massyframework.beanskin.service.ExportServiceDescriptorBuilder;

/**
 * {@link FrameworkConfig}, 运行框架配置项目
 * @author huangkh
 *
 */
public interface FrameworkConfig extends BeanRegistry{
	
	/**
	 * 部署模块的标识符
	 * <p>
	 * 系统重启时，扫描发现需要部署的模块标识符集合，存储在FrameworkConfig中。
	 * 值为: Set类型.
	 */
	static final String DEPLOY_MODULES = "deploy.modules";
		
	/**
	 * 添加Framework事件监听器
	 * @param listener {@link FrameworkListener},运行框架事件监听器
	 */
	void addListener(FrameworkListener listener);
	
	/**
	 * 添加模块事件监听器
	 * @param listener {@link ModuleListener}, 模块事件监听器
	 */
	void addListener(ModuleListener listener);
	
	/**
	 * 将{@code bean}输出为服务.
	 * <p>
	 * 当内核装配件(编号为0的装配件)启动后，会自动按输出服务定义将{@code bean}做为服务输出
	 *
	 * @param beanName {@link String}, bean名称
	 * @param bean {@link Object}, bean实例
	 * @param consumer {@link Consumer}, 消费输出服务定义构建器
	 * @throws BeanExistsException 同名bean已经存在时抛出例外
	 */
	void defineExportService(String beanName, Object bean, Consumer<ExportServiceDescriptorBuilder> consumer) throws BeanExistsException;
	
	/**
	 * 获取{@code name}对应的属性
	 * @param name {@link String},属性名
	 * @return {@link Object},可能返回null.
	 */
	Object getAttribute(String name);
	
	/**
	 * 获取{@code code}的属性
	 * @param <T>
	 * @param name {@link String},属性名
	 * @param requiredType {@link Class},要求返回的类型
	 * @return {@link T}
	 */
	default <T> T getAttribute(String name, Class<T> requiredType) {
		Object value = this.getAttribute(name);
		if (value != null) {
			return requiredType.isAssignableFrom(value.getClass()) ?
					requiredType.cast(value) : null;
		}
		return null;
	}
	
	/**
	 * 获取{@code beanName}对应的输出服务描述
	 * @param beanName {@link String}, bean名称
	 * @return {@link ExportServiceDesscriptor},可能返回null.
	 */
	ExportServiceDescriptor getExportServiceDescriptor(String beanName);	
	
	/**
	 * 按{@code name}查找参数
	 * @param name {@link String},参数名
	 * @return {@link String},参数值，可能返回null.
	 */
	String getParameter(String name);
	
	/**
	 * 按{@code name}查找参数，参数不存在则返回{@code defaultValue}.
	 * @param name {@link String},参数名
	 * @param defaultValue {@link String},缺省值
	 * @return {@link String},参数值
	 */
	default String getParameter(String name, String defaultValue) {
		String result = this.getParameter(name);
		return result == null ? defaultValue: result;
	}
	
	/**
	 * 所有参数名
	 * @return {@link List}
	 */
	List<String> getParameterNames();
	
	/**
	 * 设置属性
	 * @param name {@link String},属性名
	 * @param value {@link Object},属性值
	 */
	void setAttribute(String name, Object value);

	/**
	 * 设置参数
	 * <p>
	 * 参数已经存在后，不能再重置，此时方法返回{@code false}.
	 * 
	 * @param name {@link String},参数名
	 * @param value {@link String},参数值
	 * @return {@link boolean}，设置成功返回{@code true},否则返回{@code false}
	 */
	boolean setParameter(String name, String value);
	
	/**
	 * 移除Framework事件监听器
	 * @param listener {@link FrameworkListener},运行框架事件监听器
	 */
	void removeListener(FrameworkListener listener);
	
	/**
	 * 移除模块事件监听器
	 * @param listener {@link ModuleListener}.模块事件监听器
	 */
	void removeListener(ModuleListener listener);
}
